home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgramD2.iso / Database Designers / Rational Rose 2000 / Rational Setup.EXE / common / lib / ExtUtils / MakeMaker.pm < prev    next >
Text File  |  1999-01-25  |  61KB  |  1,934 lines
  1. BEGIN {require 5.002;} # MakeMaker 5.17 was the last MakeMaker that was compatible with perl5.001m
  2.  
  3. package ExtUtils::MakeMaker;
  4.  
  5. $Version = $VERSION = "5.4301";
  6. $Version_OK = "5.17";    # Makefiles older than $Version_OK will die
  7.             # (Will be checked from MakeMaker version 4.13 onwards)
  8. ($Revision = substr(q$Revision: 1.222 $, 10)) =~ s/\s+$//;
  9.  
  10.  
  11.  
  12. require Exporter;
  13. use Config;
  14. use Carp ();
  15. #use FileHandle ();
  16.  
  17. use vars qw(
  18.  
  19.         @ISA @EXPORT @EXPORT_OK $AUTOLOAD
  20.         $ISA_TTY $Is_Mac $Is_OS2 $Is_VMS $Revision $Setup_done
  21.         $VERSION $Verbose $Version_OK %Config %Keep_after_flush
  22.         %MM_Sections %Prepend_dot_dot %Recognized_Att_Keys
  23.         @Get_from_Config @MM_Sections @Overridable @Parent
  24.  
  25.        );
  26. # use strict;
  27.  
  28. # &DynaLoader::mod2fname should be available to miniperl, thus 
  29. # should be a pseudo-builtin (cmp. os2.c).
  30. #eval {require DynaLoader;};
  31.  
  32. #
  33. # Set up the inheritance before we pull in the MM_* packages, because they
  34. # import variables and functions from here
  35. #
  36. @ISA = qw(Exporter);
  37. @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
  38. @EXPORT_OK = qw($VERSION &Version_check &neatvalue &mkbootstrap &mksymlists
  39.         $Version);
  40.         # $Version in mixed case will go away!
  41.  
  42. #
  43. # Dummy package MM inherits actual methods from OS-specific
  44. # default packages.  We use this intermediate package so
  45. # MY::XYZ->func() can call MM->func() and get the proper
  46. # default routine without having to know under what OS
  47. # it's running.
  48. #
  49. @MM::ISA = qw[ExtUtils::MM_Unix ExtUtils::Liblist ExtUtils::MakeMaker];
  50.  
  51. #
  52. # Setup dummy package:
  53. # MY exists for overriding methods to be defined within
  54. #
  55. {
  56.     package MY;
  57.     @MY::ISA = qw(MM);
  58. ###    sub AUTOLOAD { use Devel::Symdump; print Devel::Symdump->rnew->as_string; Carp::confess "hey why? $AUTOLOAD" }
  59.     package MM;
  60.     sub DESTROY {}
  61. }
  62.  
  63. # "predeclare the package: we only load it via AUTOLOAD
  64. # but we have already mentioned it in @ISA
  65. package ExtUtils::Liblist;
  66.  
  67. package ExtUtils::MakeMaker;
  68. #
  69. # Now we can pull in the friends
  70. #
  71. $Is_VMS   = $^O eq 'VMS';
  72. $Is_OS2   = $^O eq 'os2';
  73. $Is_Mac   = $^O eq 'MacOS';
  74. $Is_Win32 = $^O eq 'MSWin32';
  75.  
  76. # This is for module authors to query, so they can enable 'CAPI' => 'TRUE'
  77. # in their Makefile.pl
  78. $CAPI_support = 1;
  79.  
  80. require ExtUtils::MM_Unix;
  81.  
  82. if ($Is_VMS) {
  83.     require ExtUtils::MM_VMS;
  84.     require VMS::Filespec; # is a noop as long as we require it within MM_VMS
  85. }
  86. if ($Is_OS2) {
  87.     require ExtUtils::MM_OS2;
  88. }
  89. if ($Is_Mac) {
  90.     require ExtUtils::MM_Mac;
  91. }
  92. if ($Is_Win32) {
  93.     require ExtUtils::MM_Win32;
  94. }
  95.  
  96. # The SelfLoader would bring a lot of overhead for MakeMaker, because
  97. # we know for sure we will use most of the autoloaded functions once
  98. # we have to use one of them. So we write our own loader
  99.  
  100. sub AUTOLOAD {
  101.     my $code;
  102.     if (defined fileno(DATA)) {
  103.     my $fh = select DATA;
  104.     my $o = $/;            # For future reads from the file.
  105.     $/ = "\n__END__\n";
  106.     $code = <DATA>;
  107.     $/ = $o;
  108.     select $fh;
  109.     close DATA;
  110.     eval $code;
  111.     if ($@) {
  112.         $@ =~ s/ at .*\n//;
  113.         Carp::croak $@;
  114.     }
  115.     } else {
  116.     warn "AUTOLOAD called unexpectedly for $AUTOLOAD"; 
  117.     }
  118.     defined(&$AUTOLOAD) or die "Myloader inconsistency error";
  119.     goto &$AUTOLOAD;
  120. }
  121.  
  122. # The only subroutine we do not SelfLoad is Version_Check because it's
  123. # called so often. Loading this minimum still requires 1.2 secs on my
  124. # Indy :-(
  125.  
  126. sub Version_check {
  127.     my($checkversion) = @_;
  128.     die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
  129. Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
  130. changes in the meantime.
  131. Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
  132.     if $checkversion < $Version_OK;
  133.     printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
  134.     $checkversion, "Current Version is", $VERSION
  135.     unless $checkversion == $VERSION;
  136. }
  137.  
  138. sub warnhandler {
  139.     $_[0] =~ /^Use of uninitialized value/ && return;
  140.     $_[0] =~ /used only once/ && return;
  141.     $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
  142.     warn @_;
  143. }
  144.  
  145. sub ExtUtils::MakeMaker::eval_in_subdirs ;
  146. sub ExtUtils::MakeMaker::eval_in_x ;
  147. sub ExtUtils::MakeMaker::full_setup ;
  148. sub ExtUtils::MakeMaker::writeMakefile ;
  149. sub ExtUtils::MakeMaker::new ;
  150. sub ExtUtils::MakeMaker::check_manifest ;
  151. sub ExtUtils::MakeMaker::parse_args ;
  152. sub ExtUtils::MakeMaker::check_hints ;
  153. sub ExtUtils::MakeMaker::mv_all_methods ;
  154. sub ExtUtils::MakeMaker::skipcheck ;
  155. sub ExtUtils::MakeMaker::flush ;
  156. sub ExtUtils::MakeMaker::mkbootstrap ;
  157. sub ExtUtils::MakeMaker::mksymlists ;
  158. sub ExtUtils::MakeMaker::neatvalue ;
  159. sub ExtUtils::MakeMaker::selfdocument ;
  160. sub ExtUtils::MakeMaker::WriteMakefile ;
  161. sub ExtUtils::MakeMaker::prompt ($;$) ;
  162.  
  163. 1;
  164.  
  165. __DATA__
  166.  
  167. package ExtUtils::MakeMaker;
  168.  
  169. sub WriteMakefile {
  170.     Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
  171.     local $SIG{__WARN__} = \&warnhandler;
  172.  
  173.     unless ($Setup_done++){
  174.     full_setup();
  175.     undef &ExtUtils::MakeMaker::full_setup; #safe memory
  176.     }
  177.     my %att = @_;
  178.     MM->new(\%att)->flush;
  179. }
  180.  
  181. sub prompt ($;$) {
  182.     my($mess,$def)=@_;
  183.     $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ;    # Pipe?
  184.     Carp::confess("prompt function called without an argument") unless defined $mess;
  185.     my $dispdef = defined $def ? "[$def] " : " ";
  186.     $def = defined $def ? $def : "";
  187.     my $ans;
  188.     local $|=1;
  189.     print "$mess $dispdef";
  190.     if ($ISA_TTY) {
  191.     chomp($ans = <STDIN>);
  192.     } else {
  193.     print "$def\n";
  194.     }
  195.     return $ans || $def;
  196. }
  197.  
  198. sub eval_in_subdirs {
  199.     my($self) = @_;
  200.     my($dir);
  201.     use Cwd 'cwd';
  202.     my $pwd = cwd();
  203.  
  204.     foreach $dir (@{$self->{DIR}}){
  205.     my($abs) = $self->catdir($pwd,$dir);
  206.     $self->eval_in_x($abs);
  207.     }
  208.     chdir $pwd;
  209. }
  210.  
  211. sub eval_in_x {
  212.     my($self,$dir) = @_;
  213.     package main;
  214.     chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
  215. #    use FileHandle ();
  216. #    my $fh = new FileHandle;
  217. #    $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
  218.     local *FH;
  219.     open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
  220. #    my $eval = join "", <$fh>;
  221.     my $eval = join "", <FH>;
  222. #    $fh->close;
  223.     close FH;
  224.     eval $eval;
  225.     if ($@) {
  226. #       if ($@ =~ /prerequisites/) {
  227. #           die "MakeMaker WARNING: $@";
  228. #       } else {
  229. #           warn "WARNING from evaluation of $dir/Makefile.PL: $@";
  230. #       }
  231.     warn "WARNING from evaluation of $dir/Makefile.PL: $@";
  232.     }
  233. }
  234.  
  235. sub full_setup {
  236.     $Verbose ||= 0;
  237.     $^W=1;
  238.  
  239.     # package name for the classes into which the first object will be blessed
  240.     $PACKNAME = "PACK000";
  241.  
  242.     @Attrib_help = qw/
  243.  
  244.     AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION LICENSE_HREF CAPI
  245.     C CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
  246.     EXE_FILES EXCLUDE_EXT INCLUDE_EXT NO_VC FIRST_MAKEFILE FULLPERL H
  247.     INC INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLMAN1DIR
  248.     INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
  249.     INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
  250.     INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIBPERL_A LIB LIBS
  251.     LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
  252.     NAME NEEDS_LINKING NOECHO NORECURS OBJECT OPTIMIZE PERL PERLMAINCC
  253.     PERL_ARCHLIB PERL_LIB PERL_SRC PERM_RW PERM_RWX
  254.     PL_FILES PM PMLIBDIRS PREFIX
  255.     PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
  256.     XS_VERSION clean depend dist dynamic_lib linkext macro realclean
  257.     tool_autosplit PPM_INSTALL_SCRIPT PPM_INSTALL_EXEC
  258.  
  259.     IMPORTS
  260.  
  261.     installpm
  262.     /;
  263.  
  264.     # IMPORTS is used under OS/2
  265.  
  266.     # ^^^ installpm is deprecated, will go about Summer 96
  267.  
  268.     # @Overridable is close to @MM_Sections but not identical.  The
  269.     # order is important. Many subroutines declare macros. These
  270.     # depend on each other. Let's try to collect the macros up front,
  271.     # then pasthru, then the rules.
  272.  
  273.     # MM_Sections are the sections we have to call explicitly
  274.     # in Overridable we have subroutines that are used indirectly
  275.  
  276.  
  277.     @MM_Sections = 
  278.     qw(
  279.  
  280.  post_initialize const_config constants tool_autosplit tool_xsubpp
  281.  tools_other dist macro depend cflags const_loadlibs const_cccmd
  282.  post_constants
  283.  
  284.  pasthru
  285.  
  286.  c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
  287.  dynamic_lib static static_lib manifypods processPL installbin subdirs
  288.  clean realclean dist_basics dist_core dist_dir dist_test dist_ci
  289.  install force perldepend makefile staticmake test ppd
  290.  
  291.       ); # loses section ordering
  292.  
  293.     @Overridable = @MM_Sections;
  294.     push @Overridable, qw[
  295.  
  296.  dir_target libscan makeaperl needs_linking perm_rw perm_rwx
  297.  subdir_x test_via_harness test_via_script
  298.  
  299.              ];
  300.  
  301.     push @MM_Sections, qw[
  302.  
  303.  pm_to_blib selfdocument
  304.  
  305.              ];
  306.  
  307.     # Postamble needs to be the last that was always the case
  308.     push @MM_Sections, "postamble";
  309.     push @Overridable, "postamble";
  310.  
  311.     # All sections are valid keys.
  312.     @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
  313.  
  314.     # we will use all these variables in the Makefile
  315.     @Get_from_Config = 
  316.     qw(
  317.        ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
  318.        lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so exe_ext
  319.       );
  320.  
  321.     my $item;
  322.     foreach $item (@Attrib_help){
  323.     $Recognized_Att_Keys{$item} = 1;
  324.     }
  325.     foreach $item (@Get_from_Config) {
  326.     $Recognized_Att_Keys{uc $item} = $Config{$item};
  327.     print "Attribute '\U$item\E' => '$Config{$item}'\n"
  328.         if ($Verbose >= 2);
  329.     }
  330.  
  331.     #
  332.     # When we eval a Makefile.PL in a subdirectory, that one will ask
  333.     # us (the parent) for the values and will prepend "..", so that
  334.     # all files to be installed end up below OUR ./blib
  335.     #
  336.     %Prepend_dot_dot = 
  337.     qw(
  338.  
  339.        INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT
  340.        1 MAP_TARGET 1 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1
  341.        PERL 1 FULLPERL 1
  342.  
  343.       );
  344.  
  345.     my @keep = qw/
  346.     NEEDS_LINKING HAS_LINK_CODE
  347.     /;
  348.     @Keep_after_flush{@keep} = (1) x @keep;
  349. }
  350.  
  351. sub writeMakefile {
  352.     die <<END;
  353.  
  354. The extension you are trying to build apparently is rather old and
  355. most probably outdated. We detect that from the fact, that a
  356. subroutine "writeMakefile" is called, and this subroutine is not
  357. supported anymore since about October 1994.
  358.  
  359. Please contact the author or look into CPAN (details about CPAN can be
  360. found in the FAQ and at http:/www.perl.com) for a more recent version
  361. of the extension. If you're really desperate, you can try to change
  362. the subroutine name from writeMakefile to WriteMakefile and rerun
  363. 'perl Makefile.PL', but you're most probably left alone, when you do
  364. so.
  365.  
  366. The MakeMaker team
  367.  
  368. END
  369. }
  370.  
  371. sub ExtUtils::MakeMaker::new {
  372.     my($class,$self) = @_;
  373.     my($key);
  374.  
  375.     print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
  376.     if (-f "MANIFEST" && ! -f "Makefile"){
  377.     check_manifest();
  378.     }
  379.  
  380.     $self = {} unless (defined $self);
  381.  
  382.     check_hints($self);
  383.  
  384.     my(%initial_att) = %$self; # record initial attributes
  385.  
  386.     my($prereq);
  387.     foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
  388.     my $eval = "use $prereq $self->{PREREQ_PM}->{$prereq}";
  389.     eval $eval;
  390.     if ($@){
  391.         warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
  392. # Why is/was this 'delete' here?  We need PREREQ_PM later to make PPDs.
  393. #    } else {
  394. #        delete $self->{PREREQ_PM}{$prereq};
  395.     }
  396.     }
  397. #    if (@unsatisfied){
  398. #       unless (defined $ExtUtils::MakeMaker::useCPAN) {
  399. #           print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
  400. # Please install these modules first and rerun 'perl Makefile.PL'.\n};
  401. #           if ($ExtUtils::MakeMaker::hasCPAN) {
  402. #           $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
  403. #           } else {
  404. #           print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
  405. #           $ExtUtils::MakeMaker::useCPAN=0;
  406. #           }
  407. #       }
  408. #       if ($ExtUtils::MakeMaker::useCPAN) {
  409. #           require CPAN;
  410. #           CPAN->import(@unsatisfied);
  411. #       } else {
  412. #           die qq{prerequisites not found (@unsatisfied)};
  413. #       }
  414. #    warn qq{WARNING: prerequisites not found (@unsatisfied)};
  415. #    }
  416.  
  417.     if (defined $self->{CONFIGURE}) {
  418.     if (ref $self->{CONFIGURE} eq 'CODE') {
  419.         $self = { %$self, %{&{$self->{CONFIGURE}}}};
  420.     } else {
  421.         Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
  422.     }
  423.     }
  424.  
  425.     # This is for old Makefiles written pre 5.00, will go away
  426.     if ( Carp::longmess("") =~ /runsubdirpl/s ){
  427.     Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
  428.     }
  429.  
  430.     my $newclass = ++$PACKNAME;
  431.     {
  432. #    no strict;
  433.     print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
  434.     mv_all_methods("MY",$newclass);
  435.     bless $self, $newclass;
  436.     push @Parent, $self;
  437.     @{"$newclass\:\:ISA"} = 'MM';
  438.     }
  439.  
  440.     if (defined $Parent[-2]){
  441.     $self->{PARENT} = $Parent[-2];
  442.     my $key;
  443.     for $key (keys %Prepend_dot_dot) {
  444.         next unless defined $self->{PARENT}{$key};
  445.         $self->{$key} = $self->{PARENT}{$key};
  446.         # PERL and FULLPERL may be command verbs instead of full
  447.         # file specifications under VMS.  If so, don't turn them
  448.         # into a filespec.
  449.         $self->{$key} = $self->catdir("..",$self->{$key})
  450.         unless $self->file_name_is_absolute($self->{$key})
  451.         || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
  452.     }
  453.     $self->{PARENT}->{CHILDREN}->{$newclass} = $self if $self->{PARENT};
  454.     } else {
  455.     parse_args($self,@ARGV);
  456.     }
  457.  
  458.     $self->{NAME} ||= $self->guess_name;
  459.  
  460.     ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
  461.  
  462.     $self->init_main();
  463.  
  464.     if (! $self->{PERL_SRC} ) {
  465.     my($pthinks) = $self->canonpath($INC{'Config.pm'});
  466.     my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
  467.     $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
  468.     if ($pthinks ne $cthinks &&
  469.         !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
  470.             print "Have $pthinks expected $cthinks\n";
  471.         if ($Is_Win32) {
  472.         $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
  473.         }
  474.         else {
  475.         $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
  476.         }
  477.         print STDOUT <<END;
  478. Your perl and your Config.pm seem to have different ideas about the architecture
  479. they are running on.
  480. Perl thinks: [$pthinks]
  481. Config says: [$Config{archname}]
  482. This may or may not cause problems. Please check your installation of perl if you
  483. have problems building this extension.
  484. END
  485.     }
  486.     }
  487.  
  488.     $self->init_dirscan();
  489.     $self->init_others();
  490.  
  491.     push @{$self->{RESULT}}, <<END;
  492. # This Makefile is for the $self->{NAME} extension to perl.
  493. #
  494. # It was generated automatically by MakeMaker version
  495. # $VERSION (Revision: $Revision) from the contents of
  496. # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
  497. #
  498. #    ANY CHANGES MADE HERE WILL BE LOST!
  499. #
  500. #   MakeMaker Parameters:
  501. END
  502.  
  503.     foreach $key (sort keys %initial_att){
  504.     my($v) = neatvalue($initial_att{$key});
  505.     $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
  506.     $v =~ tr/\n/ /s;
  507.     push @{$self->{RESULT}}, "#    $key => $v";
  508.     }
  509.  
  510.     # turn the SKIP array into a SKIPHASH hash
  511.     my (%skip,$skip);
  512.     for $skip (@{$self->{SKIP} || []}) {
  513.     $self->{SKIPHASH}{$skip} = 1;
  514.     }
  515.     delete $self->{SKIP}; # free memory
  516.  
  517.     if ($self->{PARENT}) {
  518.     for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
  519.         $self->{SKIPHASH}{$_} = 1;
  520.     }
  521.     }
  522.  
  523.     # We run all the subdirectories now. They don't have much to query
  524.     # from the parent, but the parent has to query them: if they need linking!
  525.     unless ($self->{NORECURS}) {
  526.     $self->eval_in_subdirs if @{$self->{DIR}};
  527.     }
  528.  
  529.     my $section;
  530.     foreach $section ( @MM_Sections ){
  531.     print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
  532.     my($skipit) = $self->skipcheck($section);
  533.     if ($skipit){
  534.         push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
  535.     } else {
  536.         my(%a) = %{$self->{$section} || {}};
  537.         push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
  538.         push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
  539.         push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
  540.     }
  541.     }
  542.  
  543.     push @{$self->{RESULT}}, "\n# End.";
  544.     pop @Parent;
  545.  
  546.     $self;
  547. }
  548.  
  549. sub WriteEmptyMakefile {
  550.   if (-f 'Makefile.old') {
  551.     chmod 0666, 'Makefile.old';
  552.     unlink 'Makefile.old' or warn "unlink Makefile.old: $!";
  553.   }
  554.   rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!"
  555.     if -f 'Makefile';
  556.   open MF, '> Makefile' or die "open Makefile for write: $!";
  557.   print MF <<'EOP';
  558. all:
  559.  
  560. clean:
  561.  
  562. install:
  563.  
  564. makemakerdflt:
  565.  
  566. test:
  567.  
  568. EOP
  569.   close MF or die "close Makefile for write: $!";
  570. }
  571.  
  572. sub check_manifest {
  573.     print STDOUT "Checking if your kit is complete...\n";
  574.     require ExtUtils::Manifest;
  575.     $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
  576.     my(@missed)=ExtUtils::Manifest::manicheck();
  577.     if (@missed){
  578.     print STDOUT "Warning: the following files are missing in your kit:\n";
  579.     print "\t", join "\n\t", @missed;
  580.     print STDOUT "\n";
  581.     print STDOUT "Please inform the author.\n";
  582.     } else {
  583.     print STDOUT "Looks good\n";
  584.     }
  585. }
  586.  
  587. sub parse_args{
  588.     my($self, @args) = @_;
  589.     foreach (@args){
  590.     unless (m/(.*?)=(.*)/){
  591.         help(),exit 1 if m/^help$/;
  592.         ++$Verbose if m/^verb/;
  593.         next;
  594.     }
  595.     my($name, $value) = ($1, $2);
  596.     if ($value =~ m/^~(\w+)?/){ # tilde with optional username
  597.         $value =~ s [^~(\w*)]
  598.         [$1 ?
  599.          ((getpwnam($1))[7] || "~$1") :
  600.          (getpwuid($>))[7]
  601.          ]ex;
  602.     }
  603.     $self->{uc($name)} = $value;
  604.     }
  605.  
  606.     # catch old-style 'potential_libs' and inform user how to 'upgrade'
  607.     if (defined $self->{potential_libs}){
  608.     my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
  609.     if ($self->{potential_libs}){
  610.         print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
  611.     } else {
  612.         print STDOUT "$msg deleted.\n";
  613.     }
  614.     $self->{LIBS} = [$self->{potential_libs}];
  615.     delete $self->{potential_libs};
  616.     }
  617.     # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
  618.     if (defined $self->{ARMAYBE}){
  619.     my($armaybe) = $self->{ARMAYBE};
  620.     print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
  621.             "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
  622.     my(%dl) = %{$self->{dynamic_lib} || {}};
  623.     $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
  624.     delete $self->{ARMAYBE};
  625.     }
  626.     if (defined $self->{LDTARGET}){
  627.     print STDOUT "LDTARGET should be changed to LDFROM\n";
  628.     $self->{LDFROM} = $self->{LDTARGET};
  629.     delete $self->{LDTARGET};
  630.     }
  631.     # Turn a DIR argument on the command line into an array
  632.     if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
  633.     # So they can choose from the command line, which extensions they want
  634.     # the grep enables them to have some colons too much in case they
  635.     # have to build a list with the shell
  636.     $self->{DIR} = [grep $_, split ":", $self->{DIR}];
  637.     }
  638.     # Turn a INCLUDE_EXT argument on the command line into an array
  639.     if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
  640.     $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
  641.     }
  642.     # Turn a EXCLUDE_EXT argument on the command line into an array
  643.     if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
  644.     $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
  645.     }
  646.     my $mmkey;
  647.     foreach $mmkey (sort keys %$self){
  648.     print STDOUT "    $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
  649.     print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
  650.         unless exists $Recognized_Att_Keys{$mmkey};
  651.     }
  652.     $| = 1 if $Verbose;
  653. }
  654.  
  655. sub check_hints {
  656.     my($self) = @_;
  657.     # We allow extension-specific hints files.
  658.  
  659.     return unless -d "hints";
  660.  
  661.     # First we look for the best hintsfile we have
  662.     my(@goodhints);
  663.     my($hint)="${^O}_$Config{osvers}";
  664.     $hint =~ s/\./_/g;
  665.     $hint =~ s/_$//;
  666.     return unless $hint;
  667.  
  668.     # Also try without trailing minor version numbers.
  669.     while (1) {
  670.     last if -f "hints/$hint.pl";      # found
  671.     } continue {
  672.     last unless $hint =~ s/_[^_]*$//; # nothing to cut off
  673.     }
  674.     return unless -f "hints/$hint.pl";    # really there
  675.  
  676.     # execute the hintsfile:
  677. #    use FileHandle ();
  678. #    my $fh = new FileHandle;
  679. #    $fh->open("hints/$hint.pl");
  680.     local *FH;
  681.     open(FH,"hints/$hint.pl");
  682. #    @goodhints = <$fh>;
  683.     @goodhints = <FH>;
  684. #    $fh->close;
  685.     close FH;
  686.     print STDOUT "Processing hints file hints/$hint.pl\n";
  687.     eval join('',@goodhints);
  688.     print STDOUT $@ if $@;
  689. }
  690.  
  691. sub mv_all_methods {
  692.     my($from,$to) = @_;
  693.     my($method);
  694.     my($symtab) = \%{"${from}::"};
  695. #    no strict;
  696.  
  697.     # Here you see the *current* list of methods that are overridable
  698.     # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
  699.     # still trying to reduce the list to some reasonable minimum --
  700.     # because I want to make it easier for the user. A.K.
  701.  
  702.     foreach $method (@Overridable) {
  703.  
  704.     # We cannot say "next" here. Nick might call MY->makeaperl
  705.     # which isn't defined right now
  706.  
  707.     # Above statement was written at 4.23 time when Tk-b8 was
  708.     # around. As Tk-b9 only builds with 5.002something and MM 5 is
  709.     # standard, we try to enable the next line again. It was
  710.     # commented out until MM 5.23
  711.  
  712.     next unless defined &{"${from}::$method"};
  713.  
  714.     *{"${to}::$method"} = \&{"${from}::$method"};
  715.  
  716.     # delete would do, if we were sure, nobody ever called
  717.     # MY->makeaperl directly
  718.     
  719.     # delete $symtab->{$method};
  720.     
  721.     # If we delete a method, then it will be undefined and cannot
  722.     # be called.  But as long as we have Makefile.PLs that rely on
  723.     # %MY:: being intact, we have to fill the hole with an
  724.     # inheriting method:
  725.  
  726.     eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
  727.     }
  728.  
  729.     # We have to clean out %INC also, because the current directory is
  730.     # changed frequently and Graham Barr prefers to get his version
  731.     # out of a History.pl file which is "required" so woudn't get
  732.     # loaded again in another extension requiring a History.pl
  733.  
  734.     # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
  735.     # to core dump in the middle of a require statement. The required
  736.     # file was Tk/MMutil.pm.  The consequence is, we have to be
  737.     # extremely careful when we try to give perl a reason to reload a
  738.     # library with same name.  The workaround prefers to drop nothing
  739.     # from %INC and teach the writers not to use such libraries.
  740.  
  741. #    my $inc;
  742. #    foreach $inc (keys %INC) {
  743. #    #warn "***$inc*** deleted";
  744. #    delete $INC{$inc};
  745. #    }
  746. }
  747.  
  748. sub skipcheck {
  749.     my($self) = shift;
  750.     my($section) = @_;
  751.     if ($section eq 'dynamic') {
  752.     print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
  753.     "in skipped section 'dynamic_bs'\n"
  754.             if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
  755.         print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
  756.     "in skipped section 'dynamic_lib'\n"
  757.             if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
  758.     }
  759.     if ($section eq 'dynamic_lib') {
  760.         print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
  761.     "targets in skipped section 'dynamic_bs'\n"
  762.             if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
  763.     }
  764.     if ($section eq 'static') {
  765.         print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
  766.     "in skipped section 'static_lib'\n"
  767.             if $self->{SKIPHASH}{static_lib} && $Verbose;
  768.     }
  769.     return 'skipped' if $self->{SKIPHASH}{$section};
  770.     return '';
  771. }
  772.  
  773. sub flush {
  774.     my $self = shift;
  775.     my($chunk);
  776. #    use FileHandle ();
  777. #    my $fh = new FileHandle;
  778.     local *FH;
  779.     print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
  780.  
  781.     unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
  782. #    $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
  783.     open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
  784.  
  785.     for $chunk (@{$self->{RESULT}}) {
  786. #    print $fh "$chunk\n";
  787.     print FH "$chunk\n";
  788.     }
  789.  
  790. #    $fh->close;
  791.     close FH;
  792.     my($finalname) = $self->{MAKEFILE};
  793.     rename("MakeMaker.tmp", $finalname);
  794.     chmod 0644, $finalname unless $Is_VMS;
  795.  
  796.     if ($self->{PARENT}) {
  797.     foreach (keys %$self) { # safe memory
  798.         delete $self->{$_} unless $Keep_after_flush{$_};
  799.     }
  800.     }
  801.  
  802.     system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
  803. }
  804.  
  805. # The following mkbootstrap() is only for installations that are calling
  806. # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
  807. # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
  808. sub mkbootstrap {
  809.     die <<END;
  810. !!! Your Makefile has been built such a long time ago, !!!
  811. !!! that is unlikely to work with current MakeMaker.   !!!
  812. !!! Please rebuild your Makefile                       !!!
  813. END
  814. }
  815.  
  816. # Ditto for mksymlists() as of MakeMaker 5.17
  817. sub mksymlists {
  818.     die <<END;
  819. !!! Your Makefile has been built such a long time ago, !!!
  820. !!! that is unlikely to work with current MakeMaker.   !!!
  821. !!! Please rebuild your Makefile                       !!!
  822. END
  823. }
  824.  
  825. sub neatvalue {
  826.     my($v) = @_;
  827.     return "undef" unless defined $v;
  828.     my($t) = ref $v;
  829.     return "q[$v]" unless $t;
  830.     if ($t eq 'ARRAY') {
  831.     my(@m, $elem, @neat);
  832.     push @m, "[";
  833.     foreach $elem (@$v) {
  834.         push @neat, "q[$elem]";
  835.     }
  836.     push @m, join ", ", @neat;
  837.     push @m, "]";
  838.     return join "", @m;
  839.     }
  840.     return "$v" unless $t eq 'HASH';
  841.     my(@m, $key, $val);
  842.     while (($key,$val) = each %$v){
  843.     last unless defined $key; # cautious programming in case (undef,undef) is true
  844.     push(@m,"$key=>".neatvalue($val)) ;
  845.     }
  846.     return "{ ".join(', ',@m)." }";
  847. }
  848.  
  849. sub selfdocument {
  850.     my($self) = @_;
  851.     my(@m);
  852.     if ($Verbose){
  853.     push @m, "\n# Full list of MakeMaker attribute values:";
  854.     foreach $key (sort keys %$self){
  855.         next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
  856.         my($v) = neatvalue($self->{$key});
  857.         $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
  858.         $v =~ tr/\n/ /s;
  859.         push @m, "#    $key => $v";
  860.     }
  861.     }
  862.     join "\n", @m;
  863. }
  864.  
  865. package ExtUtils::MakeMaker;
  866. 1;
  867.  
  868. __END__
  869.  
  870. =head1 NAME
  871.  
  872. ExtUtils::MakeMaker - create an extension Makefile
  873.  
  874. =head1 SYNOPSIS
  875.  
  876. C<use ExtUtils::MakeMaker;>
  877.  
  878. C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
  879.  
  880. which is really
  881.  
  882. C<MM-E<gt>new(\%att)-E<gt>flush;>
  883.  
  884. =head1 DESCRIPTION
  885.  
  886. This utility is designed to write a Makefile for an extension module
  887. from a Makefile.PL. It is based on the Makefile.SH model provided by
  888. Andy Dougherty and the perl5-porters.
  889.  
  890. It splits the task of generating the Makefile into several subroutines
  891. that can be individually overridden.  Each subroutine returns the text
  892. it wishes to have written to the Makefile.
  893.  
  894. MakeMaker is object oriented. Each directory below the current
  895. directory that contains a Makefile.PL. Is treated as a separate
  896. object. This makes it possible to write an unlimited number of
  897. Makefiles with a single invocation of WriteMakefile().
  898.  
  899. =head2 How To Write A Makefile.PL
  900.  
  901. The short answer is: Don't.
  902.  
  903.         Always begin with h2xs.
  904.         Always begin with h2xs!
  905.         ALWAYS BEGIN WITH H2XS!
  906.  
  907. even if you're not building around a header file, and even if you
  908. don't have an XS component.
  909.  
  910. Run h2xs(1) before you start thinking about writing a module. For so
  911. called pm-only modules that consist of C<*.pm> files only, h2xs has
  912. the C<-X> switch. This will generate dummy files of all kinds that are
  913. useful for the module developer.
  914.  
  915. The medium answer is:
  916.  
  917.     use ExtUtils::MakeMaker;
  918.     WriteMakefile( NAME => "Foo::Bar" );
  919.  
  920. The long answer is the rest of the manpage :-)
  921.  
  922. =head2 Default Makefile Behaviour
  923.  
  924. The generated Makefile enables the user of the extension to invoke
  925.  
  926.   perl Makefile.PL # optionally "perl Makefile.PL verbose"
  927.   make
  928.   make test        # optionally set TEST_VERBOSE=1
  929.   make install     # See below
  930.  
  931. The Makefile to be produced may be altered by adding arguments of the
  932. form C<KEY=VALUE>. E.g.
  933.  
  934.   perl Makefile.PL PREFIX=/tmp/myperl5
  935.  
  936. Other interesting targets in the generated Makefile are
  937.  
  938.   make config     # to check if the Makefile is up-to-date
  939.   make clean      # delete local temp files (Makefile gets renamed)
  940.   make realclean  # delete derived files (including ./blib)
  941.   make ci         # check in all the files in the MANIFEST file
  942.   make dist       # see below the Distribution Support section
  943.  
  944. =head2 make test
  945.  
  946. MakeMaker checks for the existence of a file named F<test.pl> in the
  947. current directory and if it exists it adds commands to the test target
  948. of the generated Makefile that will execute the script with the proper
  949. set of perl C<-I> options.
  950.  
  951. MakeMaker also checks for any files matching glob("t/*.t"). It will
  952. add commands to the test target of the generated Makefile that execute
  953. all matching files via the L<Test::Harness> module with the C<-I>
  954. switches set correctly.
  955.  
  956. =head2 make testdb
  957.  
  958. A useful variation of the above is the target C<testdb>. It runs the
  959. test under the Perl debugger (see L<perldebug>). If the file
  960. F<test.pl> exists in the current directory, it is used for the test.
  961.  
  962. If you want to debug some other testfile, set C<TEST_FILE> variable
  963. thusly:
  964.  
  965.   make testdb TEST_FILE=t/mytest.t
  966.  
  967. By default the debugger is called using C<-d> option to perl. If you
  968. want to specify some other option, set C<TESTDB_SW> variable:
  969.  
  970.   make testdb TESTDB_SW=-Dx
  971.  
  972. =head2 make install
  973.  
  974. make alone puts all relevant files into directories that are named by
  975. the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR, and
  976. INST_MAN3DIR. All these default to something below ./blib if you are
  977. I<not> building below the perl source directory. If you I<are>
  978. building below the perl source, INST_LIB and INST_ARCHLIB default to
  979.  ../../lib, and INST_SCRIPT is not defined.
  980.  
  981. The I<install> target of the generated Makefile copies the files found
  982. below each of the INST_* directories to their INSTALL*
  983. counterparts. Which counterparts are chosen depends on the setting of
  984. INSTALLDIRS according to the following table:
  985.  
  986.                       INSTALLDIRS set to
  987.                               perl                 site
  988.  
  989.     INST_ARCHLIB    INSTALLARCHLIB    INSTALLSITEARCH
  990.     INST_LIB        INSTALLPRIVLIB    INSTALLSITELIB
  991.     INST_BIN                  INSTALLBIN
  992.     INST_SCRIPT              INSTALLSCRIPT
  993.     INST_MAN1DIR             INSTALLMAN1DIR
  994.     INST_MAN3DIR             INSTALLMAN3DIR
  995.  
  996. The INSTALL... macros in turn default to their %Config
  997. ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
  998.  
  999. You can check the values of these variables on your system with
  1000.  
  1001.     perl '-V:install.*'
  1002.  
  1003. And to check the sequence in which the library directories are
  1004. searched by perl, run
  1005.  
  1006.     perl -le 'print join $/, @INC'
  1007.  
  1008.  
  1009. =head2 PREFIX and LIB attribute
  1010.  
  1011. PREFIX and LIB can be used to set several INSTALL* attributes in one
  1012. go. The quickest way to install a module in a non-standard place might
  1013. be
  1014.  
  1015.     perl Makefile.PL LIB=~/lib
  1016.  
  1017. This will install the module's architecture-independent files into
  1018. ~/lib, the architecture-dependent files into ~/lib/$archname/auto.
  1019.  
  1020. Another way to specify many INSTALL directories with a single
  1021. parameter is PREFIX.
  1022.  
  1023.     perl Makefile.PL PREFIX=~
  1024.  
  1025. This will replace the string specified by $Config{prefix} in all
  1026. $Config{install*} values.
  1027.  
  1028. Note, that in both cases the tilde expansion is done by MakeMaker, not
  1029. by perl by default, nor by make. Conflicts between parmeters LIB,
  1030. PREFIX and the various INSTALL* arguments are resolved so that 
  1031. XXX
  1032.  
  1033. If the user has superuser privileges, and is not working on AFS
  1034. (Andrew File System) or relatives, then the defaults for
  1035. INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
  1036. and this incantation will be the best:
  1037.  
  1038.     perl Makefile.PL; make; make test
  1039.     make install
  1040.  
  1041. make install per default writes some documentation of what has been
  1042. done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
  1043. can be bypassed by calling make pure_install.
  1044.  
  1045. =head2 AFS users
  1046.  
  1047. will have to specify the installation directories as these most
  1048. probably have changed since perl itself has been installed. They will
  1049. have to do this by calling
  1050.  
  1051.     perl Makefile.PL INSTALLSITELIB=/afs/here/today \
  1052.     INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
  1053.     make
  1054.  
  1055. Be careful to repeat this procedure every time you recompile an
  1056. extension, unless you are sure the AFS installation directories are
  1057. still valid.
  1058.  
  1059. =head2 Static Linking of a new Perl Binary
  1060.  
  1061. An extension that is built with the above steps is ready to use on
  1062. systems supporting dynamic loading. On systems that do not support
  1063. dynamic loading, any newly created extension has to be linked together
  1064. with the available resources. MakeMaker supports the linking process
  1065. by creating appropriate targets in the Makefile whenever an extension
  1066. is built. You can invoke the corresponding section of the makefile with
  1067.  
  1068.     make perl
  1069.  
  1070. That produces a new perl binary in the current directory with all
  1071. extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
  1072. and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
  1073. UNIX, this is called Makefile.aperl (may be system dependent). If you
  1074. want to force the creation of a new perl, it is recommended, that you
  1075. delete this Makefile.aperl, so the directories are searched-through
  1076. for linkable libraries again.
  1077.  
  1078. The binary can be installed into the directory where perl normally
  1079. resides on your machine with
  1080.  
  1081.     make inst_perl
  1082.  
  1083. To produce a perl binary with a different name than C<perl>, either say
  1084.  
  1085.     perl Makefile.PL MAP_TARGET=myperl
  1086.     make myperl
  1087.     make inst_perl
  1088.  
  1089. or say
  1090.  
  1091.     perl Makefile.PL
  1092.     make myperl MAP_TARGET=myperl
  1093.     make inst_perl MAP_TARGET=myperl
  1094.  
  1095. In any case you will be prompted with the correct invocation of the
  1096. C<inst_perl> target that installs the new binary into INSTALLBIN.
  1097.  
  1098. make inst_perl per default writes some documentation of what has been
  1099. done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
  1100. can be bypassed by calling make pure_inst_perl.
  1101.  
  1102. Warning: the inst_perl: target will most probably overwrite your
  1103. existing perl binary. Use with care!
  1104.  
  1105. Sometimes you might want to build a statically linked perl although
  1106. your system supports dynamic loading. In this case you may explicitly
  1107. set the linktype with the invocation of the Makefile.PL or make:
  1108.  
  1109.     perl Makefile.PL LINKTYPE=static    # recommended
  1110.  
  1111. or
  1112.  
  1113.     make LINKTYPE=static                # works on most systems
  1114.  
  1115. =head2 Determination of Perl Library and Installation Locations
  1116.  
  1117. MakeMaker needs to know, or to guess, where certain things are
  1118. located.  Especially INST_LIB and INST_ARCHLIB (where to put the files
  1119. during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
  1120. existing modules from), and PERL_INC (header files and C<libperl*.*>).
  1121.  
  1122. Extensions may be built either using the contents of the perl source
  1123. directory tree or from the installed perl library. The recommended way
  1124. is to build extensions after you have run 'make install' on perl
  1125. itself. You can do that in any directory on your hard disk that is not
  1126. below the perl source tree. The support for extensions below the ext
  1127. directory of the perl distribution is only good for the standard
  1128. extensions that come with perl.
  1129.  
  1130. If an extension is being built below the C<ext/> directory of the perl
  1131. source then MakeMaker will set PERL_SRC automatically (e.g.,
  1132. C<../..>).  If PERL_SRC is defined and the extension is recognized as
  1133. a standard extension, then other variables default to the following:
  1134.  
  1135.   PERL_INC     = PERL_SRC
  1136.   PERL_LIB     = PERL_SRC/lib
  1137.   PERL_ARCHLIB = PERL_SRC/lib
  1138.   INST_LIB     = PERL_LIB
  1139.   INST_ARCHLIB = PERL_ARCHLIB
  1140.  
  1141. If an extension is being built away from the perl source then MakeMaker
  1142. will leave PERL_SRC undefined and default to using the installed copy
  1143. of the perl library. The other variables default to the following:
  1144.  
  1145.   PERL_INC     = $archlibexp/CORE
  1146.   PERL_LIB     = $privlibexp
  1147.   PERL_ARCHLIB = $archlibexp
  1148.   INST_LIB     = ./blib/lib
  1149.   INST_ARCHLIB = ./blib/arch
  1150.  
  1151. If perl has not yet been installed then PERL_SRC can be defined on the
  1152. command line as shown in the previous section.
  1153.  
  1154.  
  1155. =head2 Which architecture dependent directory?
  1156.  
  1157. If you don't want to keep the defaults for the INSTALL* macros,
  1158. MakeMaker helps you to minimize the typing needed: the usual
  1159. relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
  1160. by Configure at perl compilation time. MakeMaker supports the user who
  1161. sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
  1162. then MakeMaker defaults the latter to be the same subdirectory of
  1163. INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
  1164. otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
  1165. for INSTALLSITELIB and INSTALLSITEARCH.
  1166.  
  1167. MakeMaker gives you much more freedom than needed to configure
  1168. internal variables and get different results. It is worth to mention,
  1169. that make(1) also lets you configure most of the variables that are
  1170. used in the Makefile. But in the majority of situations this will not
  1171. be necessary, and should only be done, if the author of a package
  1172. recommends it (or you know what you're doing).
  1173.  
  1174. =head2 Using Attributes and Parameters
  1175.  
  1176. The following attributes can be specified as arguments to WriteMakefile()
  1177. or as NAME=VALUE pairs on the command line:
  1178.  
  1179. =cut
  1180.  
  1181. # The following "=item C" is used by the attrib_help routine
  1182. # likewise the "=back" below. So be careful when changing it!
  1183.  
  1184. =over 2
  1185.  
  1186. =item C
  1187.  
  1188. Ref to array of *.c file names. Initialised from a directory scan
  1189. and the values portion of the XS attribute hash. This is not
  1190. currently used by MakeMaker but may be handy in Makefile.PLs.
  1191.  
  1192. =item CCFLAGS
  1193.  
  1194. String that will be included in the compiler call command line between
  1195. the arguments INC and OPTIMIZE.
  1196.  
  1197. =item CONFIG
  1198.  
  1199. Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
  1200. config.sh. MakeMaker will add to CONFIG the following values anyway:
  1201. ar
  1202. cc
  1203. cccdlflags
  1204. ccdlflags
  1205. dlext
  1206. dlsrc
  1207. ld
  1208. lddlflags
  1209. ldflags
  1210. libc
  1211. lib_ext
  1212. obj_ext
  1213. ranlib
  1214. sitelibexp
  1215. sitearchexp
  1216. so
  1217.  
  1218. =item CONFIGURE
  1219.  
  1220. CODE reference. The subroutine should return a hash reference. The
  1221. hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
  1222. be determined by some evaluation method.
  1223.  
  1224. =item DEFINE
  1225.  
  1226. Something like C<"-DHAVE_UNISTD_H">
  1227.  
  1228. =item DIR
  1229.  
  1230. Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
  1231. ] in ext/SDBM_File
  1232.  
  1233. =item DISTNAME
  1234.  
  1235. Your name for distributing the package (by tar file). This defaults to
  1236. NAME above.
  1237.  
  1238. =item DL_FUNCS
  1239.  
  1240. Hashref of symbol names for routines to be made available as
  1241. universal symbols.  Each key/value pair consists of the package name
  1242. and an array of routine names in that package.  Used only under AIX
  1243. (export lists) and VMS (linker options) at present.  The routine
  1244. names supplied will be expanded in the same way as XSUB names are
  1245. expanded by the XS() macro.  Defaults to
  1246.  
  1247.   {"$(NAME)" => ["boot_$(NAME)" ] }
  1248.  
  1249. e.g.
  1250.  
  1251.   {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
  1252.    "NetconfigPtr" => [ 'DESTROY'] }
  1253.  
  1254. =item DL_VARS
  1255.  
  1256. Array of symbol names for variables to be made available as
  1257. universal symbols.  Used only under AIX (export lists) and VMS
  1258. (linker options) at present.  Defaults to [].  (e.g. [ qw(
  1259. Foo_version Foo_numstreams Foo_tree ) ])
  1260.  
  1261. =item EXCLUDE_EXT
  1262.  
  1263. Array of extension names to exclude when doing a static build.  This
  1264. is ignored if INCLUDE_EXT is present.  Consult INCLUDE_EXT for more
  1265. details.  (e.g.  [ qw( Socket POSIX ) ] )
  1266.  
  1267. This attribute may be most useful when specified as a string on the
  1268. commandline:  perl Makefile.PL EXCLUDE_EXT='Socket Safe'
  1269.  
  1270. =item EXE_FILES
  1271.  
  1272. Ref to array of executable files. The files will be copied to the
  1273. INST_SCRIPT directory. Make realclean will delete them from there
  1274. again.
  1275.  
  1276. =item NO_VC
  1277.  
  1278. In general any generated Makefile checks for the current version of
  1279. MakeMaker and the version the Makefile was built under. If NO_VC is
  1280. set, the version check is neglected. Do not write this into your
  1281. Makefile.PL, use it interactively instead.
  1282.  
  1283. =item FIRST_MAKEFILE
  1284.  
  1285. The name of the Makefile to be produced. Defaults to the contents of
  1286. MAKEFILE, but can be overridden. This is used for the second Makefile
  1287. that will be produced for the MAP_TARGET.
  1288.  
  1289. =item FULLPERL
  1290.  
  1291. Perl binary able to run this extension.
  1292.  
  1293. =item H
  1294.  
  1295. Ref to array of *.h file names. Similar to C.
  1296.  
  1297. =item IMPORTS
  1298.  
  1299. IMPORTS is only used on OS/2.
  1300.  
  1301. =item INC
  1302.  
  1303. Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
  1304.  
  1305. =item INCLUDE_EXT
  1306.  
  1307. Array of extension names to be included when doing a static build.
  1308. MakeMaker will normally build with all of the installed extensions when
  1309. doing a static build, and that is usually the desired behavior.  If
  1310. INCLUDE_EXT is present then MakeMaker will build only with those extensions
  1311. which are explicitly mentioned. (e.g.  [ qw( Socket POSIX ) ])
  1312.  
  1313. It is not necessary to mention DynaLoader or the current extension when
  1314. filling in INCLUDE_EXT.  If the INCLUDE_EXT is mentioned but is empty then
  1315. only DynaLoader and the current extension will be included in the build.
  1316.  
  1317. This attribute may be most useful when specified as a string on the
  1318. commandline:  perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
  1319.  
  1320. =item INSTALLARCHLIB
  1321.  
  1322. Used by 'make install', which copies files from INST_ARCHLIB to this
  1323. directory if INSTALLDIRS is set to perl.
  1324.  
  1325. =item INSTALLBIN
  1326.  
  1327. Directory to install binary files (e.g. tkperl) into.
  1328.  
  1329. =item INSTALLDIRS
  1330.  
  1331. Determines which of the two sets of installation directories to
  1332. choose: installprivlib and installarchlib versus installsitelib and
  1333. installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
  1334. second with INSTALLDIRS=site. Default is site.
  1335.  
  1336. =item INSTALLMAN1DIR
  1337.  
  1338. This directory gets the man pages at 'make install' time. Defaults to
  1339. $Config{installman1dir}.
  1340.  
  1341. =item INSTALLMAN3DIR
  1342.  
  1343. This directory gets the man pages at 'make install' time. Defaults to
  1344. $Config{installman3dir}.
  1345.  
  1346. =item INSTALLPRIVLIB
  1347.  
  1348. Used by 'make install', which copies files from INST_LIB to this
  1349. directory if INSTALLDIRS is set to perl.
  1350.  
  1351. =item INSTALLSCRIPT
  1352.  
  1353. Used by 'make install' which copies files from INST_SCRIPT to this
  1354. directory.
  1355.  
  1356. =item INSTALLSITELIB
  1357.  
  1358. Used by 'make install', which copies files from INST_LIB to this
  1359. directory if INSTALLDIRS is set to site (default).
  1360.  
  1361. =item INSTALLSITEARCH
  1362.  
  1363. Used by 'make install', which copies files from INST_ARCHLIB to this
  1364. directory if INSTALLDIRS is set to site (default).
  1365.  
  1366. =item INST_ARCHLIB
  1367.  
  1368. Same as INST_LIB for architecture dependent files.
  1369.  
  1370. =item INST_BIN
  1371.  
  1372. Directory to put real binary files during 'make'. These will be copied
  1373. to INSTALLBIN during 'make install'
  1374.  
  1375. =item INST_EXE
  1376.  
  1377. Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
  1378. need to use it.
  1379.  
  1380. =item INST_LIB
  1381.  
  1382. Directory where we put library files of this extension while building
  1383. it.
  1384.  
  1385. =item INST_MAN1DIR
  1386.  
  1387. Directory to hold the man pages at 'make' time
  1388.  
  1389. =item INST_MAN3DIR
  1390.  
  1391. Directory to hold the man pages at 'make' time
  1392.  
  1393. =item INST_SCRIPT
  1394.  
  1395. Directory, where executable files should be installed during
  1396. 'make'. Defaults to "./blib/bin", just to have a dummy location during
  1397. testing. make install will copy the files in INST_SCRIPT to
  1398. INSTALLSCRIPT.
  1399.  
  1400. =item LDFROM
  1401.  
  1402. defaults to "$(OBJECT)" and is used in the ld command to specify
  1403. what files to link/load from (also see dynamic_lib below for how to
  1404. specify ld flags)
  1405.  
  1406. =item LIBPERL_A
  1407.  
  1408. The filename of the perllibrary that will be used together with this
  1409. extension. Defaults to libperl.a.
  1410.  
  1411. =item LIB
  1412.  
  1413. LIB can only be set at C<perl Makefile.PL> time. It has the effect of
  1414. setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
  1415.  
  1416. =item LIBS
  1417.  
  1418. An anonymous array of alternative library
  1419. specifications to be searched for (in order) until
  1420. at least one library is found. E.g.
  1421.  
  1422.   'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
  1423.  
  1424. Mind, that any element of the array
  1425. contains a complete set of arguments for the ld
  1426. command. So do not specify
  1427.  
  1428.   'LIBS' => ["-ltcl", "-ltk", "-lX11"]
  1429.  
  1430. See ODBM_File/Makefile.PL for an example, where an array is needed. If
  1431. you specify a scalar as in
  1432.  
  1433.   'LIBS' => "-ltcl -ltk -lX11"
  1434.  
  1435. MakeMaker will turn it into an array with one element.
  1436.  
  1437. =item LINKTYPE
  1438.  
  1439. 'static' or 'dynamic' (default unless usedl=undef in
  1440. config.sh). Should only be used to force static linking (also see
  1441. linkext below).
  1442.  
  1443. =item MAKEAPERL
  1444.  
  1445. Boolean which tells MakeMaker, that it should include the rules to
  1446. make a perl. This is handled automatically as a switch by
  1447. MakeMaker. The user normally does not need it.
  1448.  
  1449. =item MAKEFILE
  1450.  
  1451. The name of the Makefile to be produced.
  1452.  
  1453. =item MAN1PODS
  1454.  
  1455. Hashref of pod-containing files. MakeMaker will default this to all
  1456. EXE_FILES files that include POD directives. The files listed
  1457. here will be converted to man pages and installed as was requested
  1458. at Configure time.
  1459.  
  1460. =item MAN3PODS
  1461.  
  1462. Hashref of .pm and .pod files. MakeMaker will default this to all
  1463.  .pod and any .pm files that include POD directives. The files listed
  1464. here will be converted to man pages and installed as was requested
  1465. at Configure time.
  1466.  
  1467. =item MAP_TARGET
  1468.  
  1469. If it is intended, that a new perl binary be produced, this variable
  1470. may hold a name for that binary. Defaults to perl
  1471.  
  1472. =item MYEXTLIB
  1473.  
  1474. If the extension links to a library that it builds set this to the
  1475. name of the library (see SDBM_File)
  1476.  
  1477. =item NAME
  1478.  
  1479. Perl module name for this extension (DBD::Oracle). This will default
  1480. to the directory name but should be explicitly defined in the
  1481. Makefile.PL.
  1482.  
  1483. =item NEEDS_LINKING
  1484.  
  1485. MakeMaker will figure out, if an extension contains linkable code
  1486. anywhere down the directory tree, and will set this variable
  1487. accordingly, but you can speed it up a very little bit, if you define
  1488. this boolean variable yourself.
  1489.  
  1490. =item NOECHO
  1491.  
  1492. Defaults to C<@>. By setting it to an empty string you can generate a
  1493. Makefile that echos all commands. Mainly used in debugging MakeMaker
  1494. itself.
  1495.  
  1496. =item NORECURS
  1497.  
  1498. Boolean.  Attribute to inhibit descending into subdirectories.
  1499.  
  1500. =item OBJECT
  1501.  
  1502. List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
  1503. string containing all object files, e.g. "tkpBind.o
  1504. tkpButton.o tkpCanvas.o"
  1505.  
  1506. =item OPTIMIZE
  1507.  
  1508. Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
  1509. passed to subdirectory makes.
  1510.  
  1511. =item PERL
  1512.  
  1513. Perl binary for tasks that can be done by miniperl
  1514.  
  1515. =item PERLMAINCC
  1516.  
  1517. The call to the program that is able to compile perlmain.c. Defaults
  1518. to $(CC).
  1519.  
  1520. =item PERL_ARCHLIB
  1521.  
  1522. Same as above for architecture dependent files
  1523.  
  1524. =item PERL_LIB
  1525.  
  1526. Directory containing the Perl library to use.
  1527.  
  1528. =item PERL_SRC
  1529.  
  1530. Directory containing the Perl source code (use of this should be
  1531. avoided, it may be undefined)
  1532.  
  1533. =item PERM_RW
  1534.  
  1535. Desired Permission for read/writable files. Defaults to C<644>.
  1536. See also L<MM_Unix/perm_rw>.
  1537.  
  1538. =item PERM_RWX
  1539.  
  1540. Desired permission for executable files. Defaults to C<755>.
  1541. See also L<MM_Unix/perm_rwx>.
  1542.  
  1543. =item PL_FILES
  1544.  
  1545. Ref to hash of files to be processed as perl programs. MakeMaker
  1546. will default to any found *.PL file (except Makefile.PL) being keys
  1547. and the basename of the file being the value. E.g.
  1548.  
  1549.   {'foobar.PL' => 'foobar'}
  1550.  
  1551. The *.PL files are expected to produce output to the target files
  1552. themselves.
  1553.  
  1554. =item PM
  1555.  
  1556. Hashref of .pm files and *.pl files to be installed.  e.g.
  1557.  
  1558.   {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
  1559.  
  1560. By default this will include *.pm and *.pl and the files found in
  1561. the PMLIBDIRS directories.  Defining PM in the
  1562. Makefile.PL will override PMLIBDIRS.
  1563.  
  1564. =item PMLIBDIRS
  1565.  
  1566. Ref to array of subdirectories containing library files.  Defaults to
  1567. [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
  1568. they contain will be installed in the corresponding location in the
  1569. library.  A libscan() method can be used to alter the behaviour.
  1570. Defining PM in the Makefile.PL will override PMLIBDIRS.
  1571.  
  1572. =item PREFIX
  1573.  
  1574. Can be used to set the three INSTALL* attributes in one go (except for
  1575. probably INSTALLMAN1DIR, if it is not below PREFIX according to
  1576. %Config).  They will have PREFIX as a common directory node and will
  1577. branch from that node into lib/, lib/ARCHNAME or whatever Configure
  1578. decided at the build time of your perl (unless you override one of
  1579. them, of course).
  1580.  
  1581. =item PREREQ_PM
  1582.  
  1583. Hashref: Names of modules that need to be available to run this
  1584. extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
  1585. desired version is the value. If the required version number is 0, we
  1586. only check if any version is installed already.
  1587.  
  1588. =item SKIP
  1589.  
  1590. Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
  1591. Makefile. Caution! Do not use the SKIP attribute for the neglectible
  1592. speedup. It may seriously damage the resulting Makefile. Only use it,
  1593. if you really need it.
  1594.  
  1595. =item TYPEMAPS
  1596.  
  1597. Ref to array of typemap file names.  Use this when the typemaps are
  1598. in some directory other than the current directory or when they are
  1599. not named B<typemap>.  The last typemap in the list takes
  1600. precedence.  A typemap in the current directory has highest
  1601. precedence, even if it isn't listed in TYPEMAPS.  The default system
  1602. typemap has lowest precedence.
  1603.  
  1604. =item VERSION
  1605.  
  1606. Your version number for distributing the package.  This defaults to
  1607. 0.1.
  1608.  
  1609. =item VERSION_FROM
  1610.  
  1611. Instead of specifying the VERSION in the Makefile.PL you can let
  1612. MakeMaker parse a file to determine the version number. The parsing
  1613. routine requires that the file named by VERSION_FROM contains one
  1614. single line to compute the version number. The first line in the file
  1615. that contains the regular expression
  1616.  
  1617.     /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
  1618.  
  1619. will be evaluated with eval() and the value of the named variable
  1620. B<after> the eval() will be assigned to the VERSION attribute of the
  1621. MakeMaker object. The following lines will be parsed o.k.:
  1622.  
  1623.     $VERSION = '1.00';
  1624.     *VERSION = \'1.01';
  1625.     ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
  1626.     $FOO::VERSION = '1.10';
  1627.     *FOO::VERSION = \'1.11';
  1628.  
  1629. but these will fail:
  1630.  
  1631.     my $VERSION = '1.01';
  1632.     local $VERSION = '1.02';
  1633.     local $FOO::VERSION = '1.30';
  1634.  
  1635. The file named in VERSION_FROM is not added as a dependency to
  1636. Makefile. This is not really correct, but it would be a major pain
  1637. during development to have to rewrite the Makefile for any smallish
  1638. change in that file. If you want to make sure that the Makefile
  1639. contains the correct VERSION macro after any change of the file, you
  1640. would have to do something like
  1641.  
  1642.     depend => { Makefile => '$(VERSION_FROM)' }
  1643.  
  1644. See attribute C<depend> below.
  1645.  
  1646. =item XS
  1647.  
  1648. Hashref of .xs files. MakeMaker will default this.  e.g.
  1649.  
  1650.   {'name_of_file.xs' => 'name_of_file.c'}
  1651.  
  1652. The .c files will automatically be included in the list of files
  1653. deleted by a make clean.
  1654.  
  1655. =item XSOPT
  1656.  
  1657. String of options to pass to xsubpp.  This might include C<-C++> or
  1658. C<-extern>.  Do not include typemaps here; the TYPEMAP parameter exists for
  1659. that purpose.
  1660.  
  1661. =item XSPROTOARG
  1662.  
  1663. May be set to an empty string, which is identical to C<-prototypes>, or
  1664. C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
  1665. defaults to the empty string.
  1666.  
  1667. =item XS_VERSION
  1668.  
  1669. Your version number for the .xs file of this package.  This defaults
  1670. to the value of the VERSION attribute.
  1671.  
  1672. =back
  1673.  
  1674. =head2 Additional lowercase attributes
  1675.  
  1676. can be used to pass parameters to the methods which implement that
  1677. part of the Makefile.
  1678.  
  1679. =over 2
  1680.  
  1681. =item clean
  1682.  
  1683.   {FILES => "*.xyz foo"}
  1684.  
  1685. =item depend
  1686.  
  1687.   {ANY_TARGET => ANY_DEPENDECY, ...}
  1688.  
  1689. =item dist
  1690.  
  1691.   {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
  1692.   SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
  1693.   ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
  1694.  
  1695. If you specify COMPRESS, then SUFFIX should also be altered, as it is
  1696. needed to tell make the target file of the compression. Setting
  1697. DIST_CP to ln can be useful, if you need to preserve the timestamps on
  1698. your files. DIST_CP can take the values 'cp', which copies the file,
  1699. 'ln', which links the file, and 'best' which copies symbolic links and
  1700. links the rest. Default is 'best'.
  1701.  
  1702. =item dynamic_lib
  1703.  
  1704.   {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
  1705.  
  1706. =item installpm
  1707.  
  1708. Deprecated as of MakeMaker 5.23. See L<ExtUtils::MM_Unix/pm_to_blib>.
  1709.  
  1710. =item linkext
  1711.  
  1712.   {LINKTYPE => 'static', 'dynamic' or ''}
  1713.  
  1714. NB: Extensions that have nothing but *.pm files had to say
  1715.  
  1716.   {LINKTYPE => ''}
  1717.  
  1718. with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
  1719. can be deleted safely. MakeMaker recognizes, when there's nothing to
  1720. be linked.
  1721.  
  1722. =item macro
  1723.  
  1724.   {ANY_MACRO => ANY_VALUE, ...}
  1725.  
  1726. =item realclean
  1727.  
  1728.   {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
  1729.  
  1730. =item tool_autosplit
  1731.  
  1732.   {MAXLEN =E<gt> 8}
  1733.  
  1734. =back
  1735.  
  1736. =cut
  1737.  
  1738. # bug in pod2html, so leave the =back
  1739.  
  1740. # Don't delete this cut, MM depends on it!
  1741.  
  1742. =head2 Overriding MakeMaker Methods
  1743.  
  1744. If you cannot achieve the desired Makefile behaviour by specifying
  1745. attributes you may define private subroutines in the Makefile.PL.
  1746. Each subroutines returns the text it wishes to have written to
  1747. the Makefile. To override a section of the Makefile you can
  1748. either say:
  1749.  
  1750.     sub MY::c_o { "new literal text" }
  1751.  
  1752. or you can edit the default by saying something like:
  1753.  
  1754.     sub MY::c_o {
  1755.         package MY;    # so that "SUPER" works right
  1756.         my $inherited = shift->SUPER::c_o(@_);
  1757.         $inherited =~ s/old text/new text/;
  1758.         $inherited;
  1759.     }
  1760.  
  1761. If you are running experiments with embedding perl as a library into
  1762. other applications, you might find MakeMaker is not sufficient. You'd
  1763. better have a look at ExtUtils::Embed which is a collection of utilities
  1764. for embedding.
  1765.  
  1766. If you still need a different solution, try to develop another
  1767. subroutine that fits your needs and submit the diffs to
  1768. F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
  1769.  
  1770. For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
  1771.  
  1772. Here is a simple example of how to add a new target to the generated
  1773. Makefile:
  1774.  
  1775.     sub MY::postamble {
  1776.     '
  1777.     $(MYEXTLIB): sdbm/Makefile
  1778.         cd sdbm && $(MAKE) all
  1779.     ';
  1780.     }
  1781.  
  1782.  
  1783. =head2 Hintsfile support
  1784.  
  1785. MakeMaker.pm uses the architecture specific information from
  1786. Config.pm. In addition it evaluates architecture specific hints files
  1787. in a C<hints/> directory. The hints files are expected to be named
  1788. like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
  1789. name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
  1790. MakeMaker within the WriteMakefile() subroutine, and can be used to
  1791. execute commands as well as to include special variables. The rules
  1792. which hintsfile is chosen are the same as in Configure.
  1793.  
  1794. The hintsfile is eval()ed immediately after the arguments given to
  1795. WriteMakefile are stuffed into a hash reference $self but before this
  1796. reference becomes blessed. So if you want to do the equivalent to
  1797. override or create an attribute you would say something like
  1798.  
  1799.     $self->{LIBS} = ['-ldbm -lucb -lc'];
  1800.  
  1801. =head2 Distribution Support
  1802.  
  1803. For authors of extensions MakeMaker provides several Makefile
  1804. targets. Most of the support comes from the ExtUtils::Manifest module,
  1805. where additional documentation can be found.
  1806.  
  1807. =over 4
  1808.  
  1809. =item    make distcheck
  1810.  
  1811. reports which files are below the build directory but not in the
  1812. MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
  1813. details)
  1814.  
  1815. =item    make skipcheck
  1816.  
  1817. reports which files are skipped due to the entries in the
  1818. C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
  1819. details)
  1820.  
  1821. =item    make distclean
  1822.  
  1823. does a realclean first and then the distcheck. Note that this is not
  1824. needed to build a new distribution as long as you are sure, that the
  1825. MANIFEST file is ok.
  1826.  
  1827. =item    make manifest
  1828.  
  1829. rewrites the MANIFEST file, adding all remaining files found (See
  1830. ExtUtils::Manifest::mkmanifest() for details)
  1831.  
  1832. =item    make distdir
  1833.  
  1834. Copies all the files that are in the MANIFEST file to a newly created
  1835. directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
  1836. exists, it will be removed first.
  1837.  
  1838. =item    make disttest
  1839.  
  1840. Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
  1841. a make test in that directory.
  1842.  
  1843. =item    make tardist
  1844.  
  1845. First does a distdir. Then a command $(PREOP) which defaults to a null
  1846. command, followed by $(TOUNIX), which defaults to a null command under
  1847. UNIX, and will convert files in distribution directory to UNIX format
  1848. otherwise. Next it runs C<tar> on that directory into a tarfile and
  1849. deletes the directory. Finishes with a command $(POSTOP) which
  1850. defaults to a null command.
  1851.  
  1852. =item    make dist
  1853.  
  1854. Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
  1855.  
  1856. =item    make uutardist
  1857.  
  1858. Runs a tardist first and uuencodes the tarfile.
  1859.  
  1860. =item    make shdist
  1861.  
  1862. First does a distdir. Then a command $(PREOP) which defaults to a null
  1863. command. Next it runs C<shar> on that directory into a sharfile and
  1864. deletes the intermediate directory again. Finishes with a command
  1865. $(POSTOP) which defaults to a null command.  Note: For shdist to work
  1866. properly a C<shar> program that can handle directories is mandatory.
  1867.  
  1868. =item    make zipdist
  1869.  
  1870. First does a distdir. Then a command $(PREOP) which defaults to a null
  1871. command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
  1872. zipfile. Then deletes that directory. Finishes with a command
  1873. $(POSTOP) which defaults to a null command.
  1874.  
  1875. =item    make ci
  1876.  
  1877. Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
  1878.  
  1879. =back
  1880.  
  1881. Customization of the dist targets can be done by specifying a hash
  1882. reference to the dist attribute of the WriteMakefile call. The
  1883. following parameters are recognized:
  1884.  
  1885.     CI           ('ci -u')
  1886.     COMPRESS     ('gzip --best')
  1887.     POSTOP       ('@ :')
  1888.     PREOP        ('@ :')
  1889.     TO_UNIX      (depends on the system)
  1890.     RCS_LABEL    ('rcs -q -Nv$(VERSION_SYM):')
  1891.     SHAR         ('shar')
  1892.     SUFFIX       ('.gz')
  1893.     TAR          ('tar')
  1894.     TARFLAGS     ('cvf')
  1895.     ZIP          ('zip')
  1896.     ZIPFLAGS     ('-r')
  1897.  
  1898. An example:
  1899.  
  1900.     WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
  1901.  
  1902. =head2 Disabling an extension
  1903.  
  1904. If some events detected in F<Makefile.PL> imply that there is no way
  1905. to create the Module, but this is a normal state of things, then you
  1906. can create a F<Makefile> which does nothing, but succeeds on all the
  1907. "usual" build targets.  To do so, use
  1908.  
  1909.    ExtUtils::MakeMaker::WriteEmptyMakefile();
  1910.  
  1911. instead of WriteMakefile().
  1912.  
  1913. This may be useful if other modules expect this module to be I<built>
  1914. OK, as opposed to I<work> OK (say, this system-dependent module builds
  1915. in a subdirectory of some other distribution, or is listed as a
  1916. dependency in a CPAN::Bundle, but the functionality is supported by
  1917. different means on the current architecture).
  1918.  
  1919. =head1 SEE ALSO
  1920.  
  1921. ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
  1922. ExtUtils::Install, ExtUtils::Embed
  1923.  
  1924. =head1 AUTHORS
  1925.  
  1926. Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
  1927. <F<A.Koenig@franz.ww.TU-Berlin.DE>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.
  1928. VMS support by Charles Bailey <F<bailey@genetics.upenn.edu>>.  OS/2
  1929. support by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>.  Contact the
  1930. makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
  1931. you have any questions.
  1932.  
  1933. =cut
  1934.